CIECA Products

Implementation Guide - Towing Assignment Add

Populate the data you wish to transfer for the best results of your implementation, here is an example of a Towing Assignment Add Message. 

Data Dictionary Reference(s)

Section 4 

Section 4.1 - Common Data Aggregates for Assignment
Section 4.2 - Assignment Add Request

Common Elements and Aggregates

Section 3


The hyperlinks in the Type Colum will help you navigate to the Aggregates and messages.  

<ctrl> click on hyperlink will take you to the Aggregate

<alt> and back arrow will take you back to hyperlink

Data Dictionary Help

Section 2


Describes the architecture behind the schemas.  This includes definitions, data types, building blocks, naming conventions, and versioning.

Data Recommendations

Aggregate  Aggregate or Element Usage
<AssignmentAddRq><RqUID>Required
 <PartnerKey> Recommended
 <SvcProviderName>Recommended
<DocumentInfo> Required
 <BMSVer>Required; Must be populated with a value from BMS Version Code List.
 <DocumentType> Required; Must be populated with a value from the Document Type Code List. Use 'TA' for Towing Assignment.
 <CreateDateTime> Required
 <TransmsitDateTime> Recommended
<EventInfo>Required but all values in the aggregate are optional
<EventInfo> / <AssignmentEvent> Recommended; Repeating
 <RequestedDateTime>
 Recommended
<BeginDateTime> Recommended
<EndDateTime> Recommended
<EventInfo> / <SalvageEvent> / <ApprovalToMove>
 Recommended
<EventDateTime> Required
<EventInfo> / <SalvageEvent> / <ApprovalToMove> / <EventContact>
 Recommended
<ContactJobTitle> Recommended
 <EventInfo> / <SalvageEvent> / <ApprovalToMove> / <EventContact> / <Communications>
 Recommended / Repeating

 <CommQualifier>Required; Must be populated with a value from the Communication Qualifier Code List
 <CommPhone> Recommended.  If the phone number is not provided one of the following must be populated. (email, address, or Comm Instant Messaging)
  <EventInfo> / <SalvageEvent> / <ApprovalToMove> / <EventContact> / <ContactName> Recommended
 <FirstName>Recommended
<LastName>Recommended
<AliasName>Recommended
<AdminInfo> Required, All data is optional in <AdminInfo> aggregate
<VehicleLocationSite>Recommended; See Party for more details
<DestinationLocationSite> Recommended; See Party for more details
<TowCompany>Recommended; See Party for more details
<TowRequestor>Recommended; See Party for more details
 <ClaimInfo> Required and/or <OrderInfo>, <FleetInfo>
 <ClaimNum>Recommended
 <ClaimInfo> / <PolicyInfo>Recommended; repeating
 <PolicyNum>Recommended
<TowAssignment>Required or <VehicleDamageAssignment>, <RentalAssignment>, <GlassAssignment>, <SubrogationAssignment>, <PropertyDamageAssignment>.  Only one can be in a message, we are using <TowAssignment>
 <TowServiceTypeCode>Recommended; must be populated with a value from the Tow Service Type Code List
<TowAssignment> / <VehicleInfo> Required
  <VehcileMemo> Recommended
 <TowAssignment> / <VehicleInfo> / <VINInfo>Recommended; Repeating
 <TowAssignment> / <VehicleInfo> / <VINInfo> / <VIN>Required; Repeating or <VINAvailabilityCode>
 <VINNum>Required
<TowAssignment> / <VehicleInfo> / <License>Recommended
 <LicensePlateNum> Recommended
<LicensePlateStateProvince>Recommended; must be populated with a value from the State Province Code List
 <TowAssignment> / <VehicleInfo> / <VehicleDesc> Recommended
 <ModelYear>Recommended
<MakeDesc>Recommended
<ModelName>Recommended
<KeysAvilableInd>Recommended
<KeysLocationDesc>Recommended
<TowAssignment> / <VehicleInfo> / <Paint> / <Exteriror> / <Color>Recommended
<ColorName>Recommended
<TowAssignment> / <VehicleInfo> / <Condition> Recommended
 <ConditionMemo>Recommended
 <TowCondition>Recommended; must be populated with a value from the Tow Condition Code List
<TowAssignment> / <AdditionalInfo>Recommended
 <AdditionalNotes>Recommended

Master Code List

Code List are identified in the Type Column with Open Enum or Closed Enum in the Data Dictionary.  For a list of all the codes, please use the Data Dictionary and the Master Code List.

 Code List ValueDescription
 BMS Version 6.4.0In this example this is the most recent BMS Version.  You should use the BMS Version your code is implementing.
Document Type TATA is Towing Assignment
 Communications Qualifier Code AL
TE
AL - Address/Location
TE - Telephone 
Tow Service Type CodePrimary TowPrimary Tow
State Providence  MOMissouri
Tow ConditionTowableTowable